Fix invalid enum output when x-enum-descriptions contains a line break#2838
Open
greymoth-jp wants to merge 1 commit into
Open
Fix invalid enum output when x-enum-descriptions contains a line break#2838greymoth-jp wants to merge 1 commit into
greymoth-jp wants to merge 1 commit into
Conversation
🦋 Changeset detectedLatest commit: 60f988a The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
👷 Deploy request for openapi-ts pending review.Visit the deploys page to approve it
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When the
enumoption is enabled, each member's//comment is taken fromx-enum-descriptions/x-enumDescriptions. The description is handed toaddSyntheticLeadingCommentas single-line comment trivia, so a value that contains a line break ends the//comment at the first newline and the remaining text is printed as code. The generated enum then fails to parse.For example, an
x-enum-descriptionsentry of"Code 100\nspanning two lines"currently produces:addJSDocCommentalready handles this for property descriptions by running them throughLB_RE(and escaping*/), buttsEnumMemberwas the one comment path that skipped it. This change collapses internal line breaks in the enum-member description with the sameLB_RE, so it stays on the single//line:Single-line descriptions are unaffected.
Verification: added a
tsEnumunit test intest/lib/ts.test.ts. It fails onmain(the second line lands outside the comment) and passes with this change; the remainingts.test.tscases and the enum transform tests still pass.